home *** CD-ROM | disk | FTP | other *** search
/ Archive Magazine CD 1995 / Archive Magazine CD 1995.iso / discs / prog_disc / volume_6 / issue_10 / archive / Sample
Encoding:
Text File  |  1993-06-23  |  7.1 KB  |  110 lines
  1. Preparing Material for Archive
  2. Paul Beverley
  3. In order to speed up the preparation of the magazine, it would be helpful if contributors could try to 
  4. follow a set of guidelines − what you might call the “house style” of Archive.
  5. Disc format
  6. The text you send in can be in any disc format you like: 3½" or 5¼", E, D or L format − even 
  7. MSDOS if you really have to!
  8. Wordprocessor / DTP format
  9. We can cope with almost any WP/DTP format but, for preference, we would like Impression since 
  10. that is the application we actually use when producing the magazine. If you do have Impression or 
  11. Impression Junior, let us know and we will send you a sample document with the styles on it.
  12. House style
  13. For those of you who produce a lot of printed material, I know it’s difficult to change your style but, 
  14. if at all possible, I would like people to prepare their articles for Archive with a particular “house 
  15. style”. I’m not talking about your style of writing − your turn of phrase, etc − I mean the way you 
  16. lay it out. A few examples will show you what I mean.
  17. Headings
  18. If you look at the title of this article, you will see it is in titles, i.e. initial capital letters for the main 
  19. words. The section headings, however, only use an initial capital letter on the first word − except 
  20. where the word would have a capital anyway, like “Impression” or “Archive”, e.g. “How to use 
  21. Impression”.
  22. Also, note the difference between switching the heading style off at the beginning of the next 
  23. paragraph (as in the title of this section) rather than at the end of the heading line (as in the 
  24. following title), i.e. the heading gets separated from the paragraph by a space.
  25. Indents
  26. There is no need to create indents, either with spaces or tabs. This is dealt with automatically by the 
  27. “styles” used in Impression. Thus, if you have a couple of lines of program to insert in the text, as 
  28. for example:
  29.  10 REM> WonderProg
  30. 100 PRINT “This is a load of rubbish”
  31. 110 GOTO 100
  32. What you should send in as text is just: 
  33.  10 REM> WonderProg
  34. 100 PRINT “This is a load of rubbish”
  35. 110 GOTO 100
  36. I then give it styles which set the typeface and add the indent. If you had already given it indents by 
  37. adding your own spaces, I would have to strip them out otherwise I would get a double indent.
  38. Tables
  39. If you have tables within the text and you lay out the data in column by using spaces, it can cause 
  40. problems. Remember that what looks OK in mono-spaced type looks funny when set in a 
  41. proportionally-spaced typeface. 
  42. Thus...
  43. Brown   6.5   13.6   11.11
  44. Alliss  2.3    9.6   88.88
  45. Mummy   1.1   11.1   99.99 
  46. may look OK when separated by spaces but if you put that into proportionally spaced text, you get:
  47.    Brown   6.5    13.6   11.11
  48.    Alliss  2.3     9.6    88.88
  49.    Mummy   1.1    11.1    99.99 
  50. If you want to use spaces to print it out, that’s fine − I then just use search & replace to change mul
  51. tiple spaces into tabs. However, if you can present it using tabs, it makes my life easier.
  52. If you are using Impression and set up a table using a ruler, remember that the text has to fit, if 
  53. possible, into a normal column width. Also, please don’t leave the names of any new rulers as 
  54. ‘Ruler1’, ‘Ruler2’, etc. Use your own name or some code word, like ‘Lynch1’, ‘Lynch2’, etc. The 
  55. reason for this is that when you paste text from one document (your article) into another (the 
  56. magazine) if a style of the same name exists, it maintains the definition specified in the destination 
  57. document, so you will lose your carefully set out tabulations.
  58. Abbreviations
  59. I try, as far as I can, to use standard abbreviations and I try to be consistent. Here are some I use:
  60. a.m. (with full stops)
  61. Basic (not BASIC − I’ve changed my mind on this one!)
  62. e.g. (with full stops)
  63. i.e. (with full stops)
  64. Kbytes or just Kb (not K and not k or kbytes. Yes, that’s a change to make it consistent with 
  65. Mbytes.)
  66. Mbytes or just Mb (and not M)
  67. p.m. (with full stops)
  68. RISC-OS (not RISC OS, Risc OS, RISCOS, etc)
  69. Please refer to the computer we all know and love as an Archimedes, not an Arc or an Archie.
  70. Archive references
  71. When referring to articles in previous issues, the convention is to use, e.g. Archive 3.4 p45.
  72. Spell-checking
  73. If possible, please run a spell-checker over your text before sending it in. (This may seem obvious 
  74. but you would be amazed at the number of people, even those using Impression, who don’t bother.)
  75. Other spelling conventions that I like to stick to are: program (unless it’s a TV programme), 
  76. iconbar, filetype and drawfile.
  77. Dashes and hyphens
  78. A hyphen is the character on the keyboard between the zero and the equals sign and is the thing 
  79. used in hyphenated words − e.g. RISC-OS − whereas dashes are produced as <alt-153> or from the 
  80. !Chars application and are used for separating bits of text − as used earlier in this sentence. On 
  81. !Chars, (in Trinity, anyway) it’s the third of the dash-like characters − under the letter y. If you are 
  82. using system font then it’s the underlined d, again under the y. In Impression, you can use <ctrl-
  83. shift-hyphen>.
  84. To save all this hassle, all you need to do is to use a double hyphen where you want a dash.
  85. Describing keyboard actions
  86. The conventions we use in Archive magazine to represent keyboard and mouse actions are best 
  87. illustrated by a bit of meaningless sample text:
  88. If you want to press the return key (no angle brackets on return) or one of the other keys I would 
  89. tell you to press <return>, or to press <N>, <Y> or <?>. To start up, press <shift-break> and use 
  90. <ctrl-shift-f5> (use f5, not F5) or double-click on the icon (<select> is assumed if you don’t 
  91. mention which mouse button) but click <adjust> (not “the right hand button”) if you want to add 
  92. something to the selection. In PipeDream we have control sequences like <ctrl-BSE> for searching 
  93. which actually means pressing <ctrl-B> and then <S> and then <E> while holding down <ctrl>. For 
  94. convenience, we put them all together in one set of angle brackets.
  95. Comments on English style
  96. One of the common errors that I have to correct is that you should never use a preposition to end a 
  97. sentence with. And you should never start a sentence with a conjunction like “and” or “but”. But 
  98. people do! However, it is OK to use “however” to start a sentence. Also, you can use “also” to start 
  99. a sentence.
  100. As a general rule, writers tend to make their paragraphs too long. It makes the text easier to read if it 
  101. is broken up into smaller logical units. Also, it is good to use (short) titles at regular intervals to 
  102. make the structure of the article easier to appreciate. This is helpful for busy people who haven’t 
  103. time to read every word of every article and just want to find the bit of a review that declares itself 
  104. to be the “Conclusion”.
  105. Writing reviews
  106. If you are writing a review, it is important to think yourself into the position of the person reading 
  107. the review who has never heard of the product. If they are thinking of buying a copy, they need to 
  108. know, at the very least, what the item is, how much it costs and who the supplier is. It is also useful 
  109. if you can mentioned the version number of the software under test so that people can see whether it 
  110. is the current version that was being tested or an earlier version.  A